<!doctype html>
<html lang="en">
<head>
    <title>API for class doc (phpAPI: PHP Documentation Creator version 6.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link rel="stylesheet" type="text/css" href="../style.css">
    <link rel="start" href="../index.html">
</head>
    <body id="doc" onload="parent.document.title=document.title;">
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    <hr />
<div class="package">Namespace phpapi</div>
<h1>Class doc</h1>
<div id="list">
    <ul>
        <li><strong>doc</strong></li></ul></li>    </ul>
</div>
<hr />
<p class="arguments">public  class <strong>doc</strong></p>
<div class="comment" id="overview_description">Base class of all Doc classes.<br /> Doc item's are representations of PHP language constructs (class, package, method,...)<br /> which have comments and have been processed by this run of phpapi.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">phpapi: PHP Documentation Creator</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">6.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov greenray.spb@gmail.com</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2015-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">/system/classes/doc.php</td>
                    </tr>
        </table>
</div>
    <h2 id="details_fields">Fields</h2>
            <div class="location">system/classes/doc.php at line 25</div>
        <pre class="arguments" id="data">public  mixed <strong><span class="green">$data</span></strong> = NULL;</pre>
        <div class="details">Data about the element created from the token stream before the object for this element was created.<br /> This array contains extra data about the element that occurs before the element definition in the token<br /> stream (including doc comment data), it is merged with the objects fields upon object completion.</div>
        <hr />
            <div class="location">system/classes/doc.php at line 28</div>
        <pre class="arguments" id="desc">public  string <strong><span class="green">$desc</span></strong></pre>
        <div class="details">Description of the package</div>
        <hr />
            <div class="location">system/classes/doc.php at line 31</div>
        <pre class="arguments" id="docComment">public  string <strong><span class="green">$docComment</span></strong> = <span class="red">""</span>;</pre>
        <div class="details">Unprocessed doc comment</div>
        <hr />
            <div class="location">system/classes/doc.php at line 34</div>
        <pre class="arguments" id="inBody">public  integer <strong><span class="green">$inBody</span></strong> = 0;</pre>
        <div class="details">Whether parsing is inside this elements curly braces</div>
        <hr />
            <div class="location">system/classes/doc.php at line 37</div>
        <pre class="arguments" id="name">public  string <strong><span class="green">$name</span></strong> = NULL;</pre>
        <div class="details">Name of this construct</div>
        <hr />
            <div class="location">system/classes/doc.php at line 40</div>
        <pre class="arguments" id="overview">public  mixed <strong><span class="green">$overview</span></strong></pre>
        <div class="details">Detailed package description</div>
        <hr />
            <div class="location">system/classes/doc.php at line 43</div>
        <pre class="arguments" id="root">public  <a href="../phpapi/rootdoc.html">rootDoc</a> <strong><span class="green">$root</span></strong> = NULL;</pre>
        <div class="details">Reference to the root element</div>
        <hr />
            <div class="location">system/classes/doc.php at line 46</div>
        <pre class="arguments" id="tags">public  <a href="../tags/tag.html">tag</a> <strong><span class="green">$tags</span></strong> = [];</pre>
        <div class="details">DocComment tags</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">system/classes/doc.php at line 49</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>()</code>
    <div class="details">
            <p class="description">Constructor.</p>
            </div>
    <h2 id="details_methods">Methods</h2>
            <div class="location">system/classes/doc.php at line 58</div>
        <code class="arguments" id="set">public  boolean <strong>set</strong> (<span class="lilac">string</span> <span class="blue">$member</span>, <span class="lilac">mixed</span> <span class="blue">$value</span>)</code>
        <div class="details">
                    <p class="description">Setter method.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$member</td>
                <td class="hid">Name of the member to set</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">mixed</td>
                            <td class="hid blue w_100">$value</td>
                <td class="hid">Value to set member to</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/classes/doc.php at line 76</div>
        <code class="arguments" id="setByRef">public  boolean <strong>setByRef</strong> (<span class="lilac">string</span> <span class="blue">$member</span>, <span class="lilac">mixed</span> <span class="blue">&$value</span>)</code>
        <div class="details">
                    <p class="description">Setter by reference method.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$member</td>
                <td class="hid">Name of the member to set</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">mixed</td>
                            <td class="hid blue w_100">&$value</td>
                <td class="hid">Reference to the value of the variable, constant, etc.</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/classes/doc.php at line 93</div>
        <code class="arguments" id="isClass">public  boolean <strong>isClass</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs a class.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 103</div>
        <code class="arguments" id="isConstructor">public  boolean <strong>isConstructor</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs a constructor.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 113</div>
        <code class="arguments" id="isException">public  boolean <strong>isException</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs an exception.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 123</div>
        <code class="arguments" id="isField">public  boolean <strong>isField</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs a field.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 133</div>
        <code class="arguments" id="isFunction">public  boolean <strong>isFunction</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs a function.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 143</div>
        <code class="arguments" id="isInterface">public  boolean <strong>isInterface</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs an interface.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 153</div>
        <code class="arguments" id="isGlobal">public  boolean <strong>isGlobal</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs a global variable.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 163</div>
        <code class="arguments" id="isMethod">public  boolean <strong>isMethod</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs a method.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 173</div>
        <code class="arguments" id="isOrdinaryClass">public  boolean <strong>isOrdinaryClass</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs an ordinary class (not an interface or an exception).<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 183</div>
        <code class="arguments" id="isTrait">public  boolean <strong>isTrait</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs an trait.<br /> False until overridden.</p>
                    </div>
        <hr />
            <div class="location">system/classes/doc.php at line 188</div>
        <code class="arguments" id="mergeData">public  void <strong>mergeData</strong> ()</code>
        <div class="details">
                    <p class="description">Merges the contents of the DocComment into the element object.</p>
                    </div>
        <hr />
        <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    </body>
</html>
